home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 1999 August / SGI Freeware 1999 August.iso / dist / fw_emacs.idb / usr / freeware / share / emacs / 19.34 / lisp / dired-aux.el.z / dired-aux.el
Encoding:
Text File  |  1998-10-28  |  71.3 KB  |  1,892 lines
  1. ;;; dired-aux.el --- less commonly used parts of dired  -*-byte-compile-dynamic: t;-*-
  2.  
  3. ;; Copyright (C) 1985, 1986, 1992, 1994 Free Software Foundation, Inc.
  4.  
  5. ;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>.
  6.  
  7. ;; This file is part of GNU Emacs.
  8.  
  9. ;; GNU Emacs is free software; you can redistribute it and/or modify
  10. ;; it under the terms of the GNU General Public License as published by
  11. ;; the Free Software Foundation; either version 2, or (at your option)
  12. ;; any later version.
  13.  
  14. ;; GNU Emacs is distributed in the hope that it will be useful,
  15. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17. ;; GNU General Public License for more details.
  18.  
  19. ;; You should have received a copy of the GNU General Public License
  20. ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  21. ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  22. ;; Boston, MA 02111-1307, USA.
  23.  
  24. ;;; Commentary:
  25.  
  26. ;; The parts of dired mode not normally used.  This is a space-saving hack
  27. ;; to avoid having to load a large mode when all that's wanted are a few
  28. ;; functions.
  29.  
  30. ;; Rewritten in 1990/1991 to add tree features, file marking and
  31. ;; sorting by Sebastian Kremer <sk@thp.uni-koeln.de>.
  32. ;; Finished up by rms in 1992.
  33.  
  34. ;;; Code:
  35.  
  36. ;; We need macros in dired.el to compile properly.
  37. (eval-when-compile (require 'dired))
  38.  
  39. ;;; 15K
  40. ;;;###begin dired-cmd.el
  41. ;; Diffing and compressing
  42.  
  43. ;;;###autoload
  44. (defun dired-diff (file &optional switches)
  45.   "Compare file at point with file FILE using `diff'.
  46. FILE defaults to the file at the mark.
  47. The prompted-for file is the first file given to `diff'.
  48. With prefix arg, prompt for second argument SWITCHES,
  49.  which is options for `diff'."
  50.   (interactive
  51.    (let ((default (if (mark t)
  52.               (save-excursion (goto-char (mark t))
  53.                       (dired-get-filename t t)))))
  54.      (require 'diff)
  55.      (list (read-file-name (format "Diff %s with: %s"
  56.                    (dired-get-filename t)
  57.                    (if default
  58.                        (concat "(default " default ") ")
  59.                      ""))
  60.                (dired-current-directory) default t)
  61.        (if current-prefix-arg
  62.            (read-string "Options for diff: "
  63.                 (if (stringp diff-switches)
  64.                 diff-switches
  65.                   (mapconcat 'identity diff-switches " ")))))))
  66.   (diff file (dired-get-filename t) switches))
  67.  
  68. ;;;###autoload
  69. (defun dired-backup-diff (&optional switches)
  70.   "Diff this file with its backup file or vice versa.
  71. Uses the latest backup, if there are several numerical backups.
  72. If this file is a backup, diff it with its original.
  73. The backup file is the first file given to `diff'.
  74. With prefix arg, prompt for argument SWITCHES which is options for `diff'."
  75.   (interactive
  76.     (if current-prefix-arg
  77.     (list (read-string "Options for diff: "
  78.                (if (stringp diff-switches)
  79.                    diff-switches
  80.                  (mapconcat 'identity diff-switches " "))))
  81.       nil))
  82.   (diff-backup (dired-get-filename) switches))
  83.  
  84. (defun dired-do-chxxx (attribute-name program op-symbol arg)
  85.   ;; Change file attributes (mode, group, owner) of marked files and
  86.   ;; refresh their file lines.
  87.   ;; ATTRIBUTE-NAME is a string describing the attribute to the user.
  88.   ;; PROGRAM is the program used to change the attribute.
  89.   ;; OP-SYMBOL is the type of operation (for use in dired-mark-pop-up).
  90.   ;; ARG describes which files to use, as in dired-get-marked-files.
  91.   (let* ((files (dired-get-marked-files t arg))
  92.      (new-attribute
  93.       (dired-mark-read-string
  94.        (concat "Change " attribute-name " of %s to: ")
  95.        nil op-symbol arg files))
  96.      (operation (concat program " " new-attribute))
  97.      failures)
  98.     (setq failures
  99.       (dired-bunch-files 10000
  100.                  (function dired-check-process)
  101.                  (list operation program new-attribute)
  102.                  files))
  103.     (dired-do-redisplay arg);; moves point if ARG is an integer
  104.     (if failures
  105.     (dired-log-summary
  106.      (format "%s: error" operation)
  107.      nil))))
  108.  
  109. ;;;###autoload
  110. (defun dired-do-chmod (&optional arg)
  111.   "Change the mode of the marked (or next ARG) files.
  112. This calls chmod, thus symbolic modes like `g+w' are allowed."
  113.   (interactive "P")
  114.   (dired-do-chxxx "Mode" dired-chmod-program 'chmod arg))
  115.  
  116. ;;;###autoload
  117. (defun dired-do-chgrp (&optional arg)
  118.   "Change the group of the marked (or next ARG) files."
  119.   (interactive "P")
  120.   (if (memq system-type '(ms-dos windows-nt))
  121.       (error "chgrp not supported on this system."))
  122.   (dired-do-chxxx "Group" "chgrp" 'chgrp arg))
  123.  
  124. ;;;###autoload
  125. (defun dired-do-chown (&optional arg)
  126.   "Change the owner of the marked (or next ARG) files."
  127.   (interactive "P")
  128.   (if (memq system-type '(ms-dos windows-nt))
  129.       (error "chown not supported on this system."))
  130.   (dired-do-chxxx "Owner" dired-chown-program 'chown arg))
  131.  
  132. ;; Process all the files in FILES in batches of a convenient size,
  133. ;; by means of (FUNCALL FUNCTION ARGS... SOME-FILES...).
  134. ;; Batches are chosen to need less than MAX chars for the file names,
  135. ;; allowing 3 extra characters of separator per file name.
  136. (defun dired-bunch-files (max function args files)
  137.   (let (pending
  138.     (pending-length 0)
  139.     failures)
  140.     ;; Accumulate files as long as they fit in MAX chars,
  141.     ;; then process the ones accumulated so far.
  142.     (while files
  143.       (let* ((thisfile (car files))
  144.          (thislength (+ (length thisfile) 3))
  145.          (rest (cdr files)))
  146.     ;; If we have at least 1 pending file
  147.     ;; and this file won't fit in the length limit, process now.
  148.     (if (and pending (> (+ thislength pending-length) max))
  149.         (setq failures
  150.           (nconc (apply function (append args pending))
  151.              failures)
  152.           pending nil
  153.           pending-length 0))
  154.     ;; Do (setq pending (cons thisfile pending))
  155.     ;; but reuse the cons that was in `files'.
  156.     (setcdr files pending)
  157.     (setq pending files)
  158.     (setq pending-length (+ thislength pending-length))
  159.     (setq files rest)))
  160.     (nconc (apply function (append args pending))
  161.        failures)))
  162.  
  163. ;;;###autoload
  164. (defun dired-do-print (&optional arg)
  165.   "Print the marked (or next ARG) files.
  166. Uses the shell command coming from variables `lpr-command' and
  167. `lpr-switches' as default."
  168.   (interactive "P")
  169.   (let* ((file-list (dired-get-marked-files t arg))
  170.      (command (dired-mark-read-string
  171.            "Print %s with: "
  172.             (mapconcat 'identity
  173.                   (cons lpr-command
  174.                     (if (stringp lpr-switches)
  175.                     (list lpr-switches)
  176.                       lpr-switches))
  177.                   " ")
  178.            'print arg file-list)))
  179.     (dired-run-shell-command (dired-shell-stuff-it command file-list nil))))
  180.  
  181. ;; Read arguments for a marked-files command that wants a string
  182. ;; that is not a file name,
  183. ;; perhaps popping up the list of marked files.
  184. ;; ARG is the prefix arg and indicates whether the files came from
  185. ;; marks (ARG=nil) or a repeat factor (integerp ARG).
  186. ;; If the current file was used, the list has but one element and ARG
  187. ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
  188.  
  189. (defun dired-mark-read-string (prompt initial op-symbol arg files)
  190.   ;; PROMPT for a string, with INITIAL input.
  191.   ;; Other args are used to give user feedback and pop-up:
  192.   ;; OP-SYMBOL of command, prefix ARG, marked FILES.
  193.   (dired-mark-pop-up
  194.    nil op-symbol files
  195.    (function read-string)
  196.    (format prompt (dired-mark-prompt arg files)) initial))
  197.  
  198. ;;; Cleaning a directory: flagging some backups for deletion.
  199.  
  200. (defvar dired-file-version-alist)
  201.  
  202. (defun dired-clean-directory (keep)
  203.   "Flag numerical backups for deletion.
  204. Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
  205. Positive prefix arg KEEP overrides `dired-kept-versions';
  206. Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
  207.  
  208. To clear the flags on these files, you can use \\[dired-flag-backup-files]
  209. with a prefix argument."
  210.   (interactive "P")
  211.   (setq keep (if keep (prefix-numeric-value keep) dired-kept-versions))
  212.   (let ((early-retention (if (< keep 0) (- keep) kept-old-versions))
  213.     (late-retention (if (<= keep 0) dired-kept-versions keep))
  214.     (dired-file-version-alist ()))
  215.     (message "Cleaning numerical backups (keeping %d late, %d old)..."
  216.          late-retention early-retention)
  217.     ;; Look at each file.
  218.     ;; If the file has numeric backup versions,
  219.     ;; put on dired-file-version-alist an element of the form
  220.     ;; (FILENAME . VERSION-NUMBER-LIST)
  221.     (dired-map-dired-file-lines (function dired-collect-file-versions))
  222.     ;; Sort each VERSION-NUMBER-LIST,
  223.     ;; and remove the versions not to be deleted.
  224.     (let ((fval dired-file-version-alist))
  225.       (while fval
  226.     (let* ((sorted-v-list (cons 'q (sort (cdr (car fval)) '<)))
  227.            (v-count (length sorted-v-list)))
  228.       (if (> v-count (+ early-retention late-retention))
  229.           (rplacd (nthcdr early-retention sorted-v-list)
  230.               (nthcdr (- v-count late-retention)
  231.                   sorted-v-list)))
  232.       (rplacd (car fval)
  233.           (cdr sorted-v-list)))
  234.     (setq fval (cdr fval))))
  235.     ;; Look at each file.  If it is a numeric backup file,
  236.     ;; find it in a VERSION-NUMBER-LIST and maybe flag it for deletion.
  237.     (dired-map-dired-file-lines (function dired-trample-file-versions))
  238.     (message "Cleaning numerical backups...done")))
  239.  
  240. ;;; Subroutines of dired-clean-directory.
  241.  
  242. (defun dired-map-dired-file-lines (fun)
  243.   ;; Perform FUN with point at the end of each non-directory line.
  244.   ;; FUN takes one argument, the filename (complete pathname).
  245.   (save-excursion
  246.     (let (file buffer-read-only)
  247.       (goto-char (point-min))
  248.       (while (not (eobp))
  249.     (save-excursion
  250.       (and (not (looking-at dired-re-dir))
  251.            (not (eolp))
  252.            (setq file (dired-get-filename nil t)) ; nil on non-file
  253.            (progn (end-of-line)
  254.               (funcall fun file))))
  255.     (forward-line 1)))))
  256.  
  257. (defun dired-collect-file-versions (fn)
  258.   (let ((fn (file-name-sans-versions fn)))
  259.     ;; Only do work if this file is not already in the alist.
  260.     (if (assoc fn dired-file-version-alist)
  261.     nil
  262.       ;; If it looks like file FN has versions, return a list of the versions.
  263.       ;;That is a list of strings which are file names.
  264.       ;;The caller may want to flag some of these files for deletion.
  265.       (let* ((base-versions
  266.           (concat (file-name-nondirectory fn) ".~"))
  267.          (bv-length (length base-versions))
  268.          (possibilities (file-name-all-completions
  269.                  base-versions
  270.                  (file-name-directory fn)))
  271.          (versions (mapcar 'backup-extract-version possibilities)))
  272.     (if versions
  273.         (setq dired-file-version-alist
  274.           (cons (cons fn versions)
  275.             dired-file-version-alist)))))))
  276.  
  277. (defun dired-trample-file-versions (fn)
  278.   (let* ((start-vn (string-match "\\.~[0-9]+~$" fn))
  279.      base-version-list)
  280.     (and start-vn
  281.      (setq base-version-list    ; there was a base version to which
  282.            (assoc (substring fn 0 start-vn)    ; this looks like a
  283.               dired-file-version-alist))    ; subversion
  284.      (not (memq (string-to-int (substring fn (+ 2 start-vn)))
  285.             base-version-list))    ; this one doesn't make the cut
  286.      (progn (beginning-of-line)
  287.         (delete-char 1)
  288.         (insert dired-del-marker)))))
  289.  
  290. ;;; Shell commands
  291. ;;>>> install (move this function into simple.el)
  292. (defun dired-shell-quote (filename)
  293.   "Quote a file name for inferior shell (see variable `shell-file-name')."
  294.   ;; Quote everything except POSIX filename characters.
  295.   ;; This should be safe enough even for really weird shells.
  296.   (let ((result "") (start 0) end)
  297.     (while (string-match "[^-0-9a-zA-Z_./]" filename start)
  298.       (setq end (match-beginning 0)
  299.         result (concat result (substring filename start end)
  300.                "\\" (substring filename end (1+ end)))
  301.         start (1+ end)))
  302.     (concat result (substring filename start))))
  303.  
  304. (defun dired-read-shell-command (prompt arg files)
  305. ;;  "Read a dired shell command prompting with PROMPT (using read-string).
  306. ;;ARG is the prefix arg and may be used to indicate in the prompt which
  307. ;;  files are affected.
  308. ;;This is an extra function so that you can redefine it, e.g., to use gmhist."
  309.   (dired-mark-pop-up
  310.    nil 'shell files
  311.    (function read-string)
  312.    (format prompt (dired-mark-prompt arg files))
  313.    nil 'shell-command-history))
  314.  
  315. ;; The in-background argument is only needed in Emacs 18 where
  316. ;; shell-command doesn't understand an appended ampersand `&'.
  317. ;;;###autoload
  318. (defun dired-do-shell-command (command &optional arg)
  319.   "Run a shell command COMMAND on the marked files.
  320. If no files are marked or a specific numeric prefix arg is given,
  321. the next ARG files are used.  Just \\[universal-argument] means the current file.
  322. The prompt mentions the file(s) or the marker, as appropriate.
  323.  
  324. If there is output, it goes to a separate buffer.
  325.  
  326. Normally the command is run on each file individually.
  327. However, if there is a `*' in the command then it is run
  328. just once with the entire file list substituted there.
  329.  
  330. No automatic redisplay of dired buffers is attempted, as there's no
  331. telling what files the command may have changed.  Type
  332. \\[dired-do-redisplay] to redisplay the marked files.
  333.  
  334. The shell command has the top level directory as working directory, so
  335. output files usually are created there instead of in a subdir."
  336. ;;Functions dired-run-shell-command and dired-shell-stuff-it do the
  337. ;;actual work and can be redefined for customization.
  338.   (interactive (list
  339.         ;; Want to give feedback whether this file or marked files are used:
  340.         (dired-read-shell-command (concat "! on "
  341.                           "%s: ")
  342.                       current-prefix-arg
  343.                       (dired-get-marked-files
  344.                        t current-prefix-arg))
  345.         current-prefix-arg))
  346.   (let* ((on-each (not (string-match "\\*" command)))
  347.      (file-list (dired-get-marked-files t arg)))
  348.     (if on-each
  349.     (dired-bunch-files
  350.      (- 10000 (length command))
  351.      (function (lambda (&rest files)
  352.              (dired-run-shell-command
  353.               (dired-shell-stuff-it command files t arg))))
  354.      nil
  355.      file-list)
  356.       ;; execute the shell command
  357.       (dired-run-shell-command
  358.        (dired-shell-stuff-it command file-list nil arg)))))
  359.  
  360. ;; Might use {,} for bash or csh:
  361. (defvar dired-mark-prefix ""
  362.   "Prepended to marked files in dired shell commands.")
  363. (defvar dired-mark-postfix ""
  364.   "Appended to marked files in dired shell commands.")
  365. (defvar dired-mark-separator " "
  366.   "Separates marked files in dired shell commands.")
  367.  
  368. (defun dired-shell-stuff-it (command file-list on-each &optional raw-arg)
  369. ;; "Make up a shell command line from COMMAND and FILE-LIST.
  370. ;; If ON-EACH is t, COMMAND should be applied to each file, else
  371. ;; simply concat all files and apply COMMAND to this.
  372. ;; FILE-LIST's elements will be quoted for the shell."
  373. ;; Might be redefined for smarter things and could then use RAW-ARG
  374. ;; (coming from interactive P and currently ignored) to decide what to do.
  375. ;; Smart would be a way to access basename or extension of file names.
  376. ;; See dired-trns.el for an approach to this.
  377.   ;; Bug: There is no way to quote a *
  378.   ;; On the other hand, you can never accidentally get a * into your cmd.
  379.   (let ((stuff-it
  380.      (if (string-match "\\*" command)
  381.          (function (lambda (x)
  382.              (dired-replace-in-string "\\*" x command)))
  383.        (function (lambda (x) (concat command " " x))))))
  384.     (if on-each
  385.     (mapconcat stuff-it (mapcar 'dired-shell-quote file-list) ";")
  386.       (let ((fns (mapconcat 'dired-shell-quote
  387.                 file-list dired-mark-separator)))
  388.     (if (> (length file-list) 1)
  389.         (setq fns (concat dired-mark-prefix fns dired-mark-postfix)))
  390.     (funcall stuff-it fns)))))
  391.  
  392. ;; This is an extra function so that it can be redefined by ange-ftp.
  393. (defun dired-run-shell-command (command)
  394.   (shell-command command)
  395.   ;; Return nil for sake of nconc in dired-bunch-files.
  396.   nil)
  397.  
  398. ;; In Emacs 19 this will return program's exit status.
  399. ;; This is a separate function so that ange-ftp can redefine it.
  400. (defun dired-call-process (program discard &rest arguments)
  401. ;  "Run PROGRAM with output to current buffer unless DISCARD is t.
  402. ;Remaining arguments are strings passed as command arguments to PROGRAM."
  403.   ;; Look for a handler for default-directory in case it is a remote file name.
  404.   (let ((handler
  405.      (find-file-name-handler (directory-file-name default-directory)
  406.                  'dired-call-process)))
  407.     (if handler (apply handler 'dired-call-process
  408.                program discard arguments)
  409.       (apply 'call-process program nil (not discard) nil arguments))))
  410.  
  411. (defun dired-check-process (msg program &rest arguments)
  412. ;  "Display MSG while running PROGRAM, and check for output.
  413. ;Remaining arguments are strings passed as command arguments to PROGRAM.
  414. ; On error, insert output
  415. ; in a log buffer and return the offending ARGUMENTS or PROGRAM.
  416. ; Caller can cons up a list of failed args.
  417. ;Else returns nil for success."
  418.   (let (err-buffer err (dir default-directory))
  419.     (message "%s..." msg)
  420.     (save-excursion
  421.       ;; Get a clean buffer for error output:
  422.       (setq err-buffer (get-buffer-create " *dired-check-process output*"))
  423.       (set-buffer err-buffer)
  424.       (erase-buffer)
  425.       (setq default-directory dir    ; caller's default-directory
  426.         err (/= 0
  427.          (apply (function dired-call-process) program nil arguments)))
  428.       (if err
  429.       (progn
  430.         (dired-log (concat program " " (prin1-to-string arguments) "\n"))
  431.         (dired-log err-buffer)
  432.         (or arguments program t))
  433.     (kill-buffer err-buffer)
  434.     (message "%s...done" msg)
  435.     nil))))
  436.  
  437. ;; Commands that delete or redisplay part of the dired buffer.
  438.  
  439. (defun dired-kill-line (&optional arg)
  440.   (interactive "P")
  441.   (setq arg (prefix-numeric-value arg))
  442.   (let (buffer-read-only file)
  443.     (while (/= 0 arg)
  444.       (setq file (dired-get-filename nil t))
  445.       (if (not file)
  446.       (error "Can only kill file lines.")
  447.     (save-excursion (and file
  448.                  (dired-goto-subdir file)
  449.                  (dired-kill-subdir)))
  450.     (delete-region (progn (beginning-of-line) (point))
  451.                (progn (forward-line 1) (point)))
  452.     (if (> arg 0)
  453.         (setq arg (1- arg))
  454.       (setq arg (1+ arg))
  455.       (forward-line -1))))
  456.     (dired-move-to-filename)))
  457.  
  458. ;;;###autoload
  459. (defun dired-do-kill-lines (&optional arg fmt)
  460.   "Kill all marked lines (not the files).
  461. With a prefix argument, kill that many lines starting with the current line.
  462. \(A negative argument kills lines before the current line.)
  463. To kill an entire subdirectory, go to its directory header line
  464. and use this command with a prefix argument (the value does not matter)."
  465.   ;; Returns count of killed lines.  FMT="" suppresses message.
  466.   (interactive "P")
  467.   (if arg
  468.       (if (dired-get-subdir)
  469.       (dired-kill-subdir)
  470.     (dired-kill-line arg))
  471.     (save-excursion
  472.       (goto-char (point-min))
  473.       (let (buffer-read-only (count 0))
  474.     (if (not arg)            ; kill marked lines
  475.         (let ((regexp (dired-marker-regexp)))
  476.           (while (and (not (eobp))
  477.               (re-search-forward regexp nil t))
  478.         (setq count (1+ count))
  479.         (delete-region (progn (beginning-of-line) (point))
  480.                    (progn (forward-line 1) (point)))))
  481.       ;; else kill unmarked lines
  482.       (while (not (eobp))
  483.         (if (or (dired-between-files)
  484.             (not (looking-at "^  ")))
  485.         (forward-line 1)
  486.           (setq count (1+ count))
  487.           (delete-region (point) (save-excursion
  488.                        (forward-line 1)
  489.                        (point))))))
  490.     (or (equal "" fmt)
  491.         (message (or fmt "Killed %d line%s.") count (dired-plural-s count)))
  492.     count))))
  493.  
  494. ;;;###end dired-cmd.el
  495.  
  496. ;;; 30K
  497. ;;;###begin dired-cp.el
  498.  
  499. (defun dired-compress ()
  500.   ;; Compress or uncompress the current file.
  501.   ;; Return nil for success, offending filename else.
  502.   (let* (buffer-read-only
  503.      (from-file (dired-get-filename))
  504.      (new-file (dired-compress-file from-file)))
  505.     (if new-file
  506.     (let ((start (point)))
  507.       ;; Remove any preexisting entry for the name NEW-FILE.
  508.       (condition-case nil
  509.           (dired-remove-entry new-file)
  510.         (error nil))
  511.       (goto-char start)
  512.       ;; Now replace the current line with an entry for NEW-FILE.
  513.       (dired-update-file-line new-file) nil)
  514.       (dired-log (concat "Failed to compress" from-file))
  515.       from-file)))
  516.  
  517. (defvar dired-compress-file-suffixes
  518.   '(("\\.gz\\'" "" "gunzip")
  519.     ("\\.tgz\\'" ".tar" "gunzip")
  520.     ("\\.Z\\'" "" "uncompress")
  521.     ;; For .z, try gunzip.  It might be an old gzip file,
  522.     ;; or it might be from compact? pack? (which?) but gunzip handles both.
  523.     ("\\.z\\'" "" "gunzip")
  524.     ;; This item controls naming for compression.
  525.     ("\\.tar\\'" ".tgz" nil))
  526.   "Control changes in file name suffixes for compression and uncompression.
  527. Each element specifies one transformation rule, and has the form:
  528.   (REGEXP NEW-SUFFIX PROGRAM)
  529. The rule applies when the old file name matches REGEXP.
  530. The new file name is computed by deleting the part that matches REGEXP
  531.  (as well as anything after that), then adding NEW-SUFFIX in its place.
  532. If PROGRAM is non-nil, the rule is an uncompression rule,
  533. and uncompression is done by running PROGRAM.
  534. Otherwise, the rule is a compression rule, and compression is done with gzip.")
  535.  
  536. ;;;###autoload
  537. (defun dired-compress-file (file)
  538.   ;; Compress or uncompress FILE.
  539.   ;; Return the name of the compressed or uncompressed file.
  540.   ;; Return nil if no change in files.
  541.   (let ((handler (find-file-name-handler file 'dired-compress-file))
  542.     suffix newname
  543.     (suffixes dired-compress-file-suffixes))
  544.     ;; See if any suffix rule matches this file name.
  545.     (while suffixes
  546.       (let (case-fold-search)
  547.     (if (string-match (car (car suffixes)) file)
  548.         (setq suffix (car suffixes) suffixes nil))
  549.     (setq suffixes (cdr suffixes))))
  550.     ;; If so, compute desired new name.
  551.     (if suffix    
  552.     (setq newname (concat (substring file 0 (match-beginning 0))
  553.                   (nth 1 suffix))))
  554.     (cond (handler
  555.        (funcall handler 'dired-compress-file file))
  556.       ((file-symlink-p file)
  557.        nil)
  558.       ((and suffix (nth 2 suffix))
  559.        ;; We found an uncompression rule.
  560.        (if (not (dired-check-process (concat "Uncompressing " file)
  561.                      (nth 2 suffix) file))
  562.            newname))
  563.       (t
  564.        ;;; We don't recognize the file as compressed, so compress it.
  565.        ;;; Try gzip; if we don't have that, use compress.
  566.        (condition-case nil
  567.            (if (not (dired-check-process (concat "Compressing " file)
  568.                          "gzip" "-f" file))
  569.            (let ((out-name
  570.               (if (file-exists-p (concat file ".gz"))
  571.                   (concat file ".gz")
  572.                 (concat file ".z"))))
  573.              ;; Rename the compressed file to NEWNAME
  574.              ;; if it hasn't got that name already.
  575.              (if (and newname (not (equal newname out-name)))
  576.              (progn
  577.                (rename-file out-name newname t)
  578.                newname)
  579.                out-name)))
  580.          (file-error
  581.           (if (not (dired-check-process (concat "Compressing " file)
  582.                         "compress" "-f" file))
  583.           ;; Don't use NEWNAME with `compress'.
  584.           (concat file ".Z"))))))))
  585.  
  586. (defun dired-mark-confirm (op-symbol arg)
  587.   ;; Request confirmation from the user that the operation described
  588.   ;; by OP-SYMBOL is to be performed on the marked files.
  589.   ;; Confirmation consists in a y-or-n question with a file list
  590.   ;; pop-up unless OP-SYMBOL is a member of `dired-no-confirm'.
  591.   ;; The files used are determined by ARG (as in dired-get-marked-files).
  592.   (or (memq op-symbol dired-no-confirm)
  593.       (let ((files (dired-get-marked-files t arg))
  594.         (string (if (eq op-symbol 'compress) "Compress or uncompress"
  595.               (capitalize (symbol-name op-symbol)))))
  596.     (dired-mark-pop-up nil op-symbol files (function y-or-n-p)
  597.                (concat string " "
  598.                    (dired-mark-prompt arg files) "? ")))))
  599.  
  600. (defun dired-map-over-marks-check (fun arg op-symbol &optional show-progress)
  601. ;  "Map FUN over marked files (with second ARG like in dired-map-over-marks)
  602. ; and display failures.
  603.  
  604. ; FUN takes zero args.  It returns non-nil (the offending object, e.g.
  605. ; the short form of the filename) for a failure and probably logs a
  606. ; detailed error explanation using function `dired-log'.
  607.  
  608. ; OP-SYMBOL is a symbol describing the operation performed (e.g.
  609. ; `compress').  It is used with `dired-mark-pop-up' to prompt the user
  610. ; (e.g. with `Compress * [2 files]? ') and to display errors (e.g.
  611. ; `Failed to compress 1 of 2 files - type W to see why ("foo")')
  612.  
  613. ; SHOW-PROGRESS if non-nil means redisplay dired after each file."
  614.   (if (dired-mark-confirm op-symbol arg)
  615.       (let* ((total-list;; all of FUN's return values
  616.           (dired-map-over-marks (funcall fun) arg show-progress))
  617.          (total (length total-list))
  618.          (failures (delq nil total-list))
  619.          (count (length failures))
  620.          (string (if (eq op-symbol 'compress) "Compress or uncompress"
  621.                (capitalize (symbol-name op-symbol)))))
  622.     (if (not failures)
  623.         (message "%s: %d file%s."
  624.              string total (dired-plural-s total))
  625.       ;; end this bunch of errors:
  626.       (dired-log-summary
  627.        (format "Failed to %s %d of %d file%s"
  628.            (downcase string) count total (dired-plural-s total))
  629.        failures)))))
  630.  
  631. (defvar dired-query-alist
  632.   '((?\y . y) (?\040 . y)        ; `y' or SPC means accept once
  633.     (?n . n) (?\177 . n)        ; `n' or DEL skips once
  634.     (?! . yes)                ; `!' accepts rest
  635.     (?q. no) (?\e . no)            ; `q' or ESC skips rest
  636.     ;; None of these keys quit - use C-g for that.
  637.     ))
  638.  
  639. (defun dired-query (qs-var qs-prompt &rest qs-args)
  640.   ;; Query user and return nil or t.
  641.   ;; Store answer in symbol VAR (which must initially be bound to nil).
  642.   ;; Format PROMPT with ARGS.
  643.   ;; Binding variable help-form will help the user who types the help key.
  644.   (let* ((char (symbol-value qs-var))
  645.      (action (cdr (assoc char dired-query-alist))))
  646.     (cond ((eq 'yes action)
  647.        t)                ; accept, and don't ask again
  648.       ((eq 'no action)
  649.        nil)                ; skip, and don't ask again
  650.       (t;; no lasting effects from last time we asked - ask now
  651.        (let ((qprompt (concat qs-prompt
  652.                   (if help-form
  653.                       (format " [Type yn!q or %s] "
  654.                           (key-description
  655.                            (char-to-string help-char)))
  656.                     " [Type y, n, q or !] ")))
  657.          result elt)
  658.          ;; Actually it looks nicer without cursor-in-echo-area - you can
  659.          ;; look at the dired buffer instead of at the prompt to decide.
  660.          (apply 'message qprompt qs-args)
  661.          (setq char (set qs-var (read-char)))
  662.          (while (not (setq elt (assoc char dired-query-alist)))
  663.            (message "Invalid char - type %c for help." help-char)
  664.            (ding)
  665.            (sit-for 1)
  666.            (apply 'message qprompt qs-args)
  667.            (setq char (set qs-var (read-char))))
  668.          (memq (cdr elt) '(t y yes)))))))
  669.  
  670. ;;;###autoload
  671. (defun dired-do-compress (&optional arg)
  672.   "Compress or uncompress marked (or next ARG) files."
  673.   (interactive "P")
  674.   (dired-map-over-marks-check (function dired-compress) arg 'compress t))
  675.  
  676. ;; Commands for Emacs Lisp files - load and byte compile
  677.  
  678. (defun dired-byte-compile ()
  679.   ;; Return nil for success, offending file name else.
  680.   (let* ((filename (dired-get-filename))
  681.      elc-file buffer-read-only failure)
  682.     (condition-case err
  683.     (save-excursion (byte-compile-file filename))
  684.       (error
  685.        (setq failure err)))
  686.     (setq elc-file (byte-compile-dest-file filename))
  687.     (or (file-exists-p elc-file)
  688.     (setq failure t))
  689.     (if failure
  690.     (progn
  691.       (dired-log "Byte compile error for %s:\n%s\n" filename failure)
  692.       (dired-make-relative filename))
  693.       (dired-remove-file elc-file)
  694.       (forward-line)            ; insert .elc after its .el file
  695.       (dired-add-file elc-file)
  696.       nil)))
  697.  
  698. ;;;###autoload
  699. (defun dired-do-byte-compile (&optional arg)
  700.   "Byte compile marked (or next ARG) Emacs Lisp files."
  701.   (interactive "P")
  702.   (dired-map-over-marks-check (function dired-byte-compile) arg 'byte-compile t))
  703.  
  704. (defun dired-load ()
  705.   ;; Return nil for success, offending file name else.
  706.   (let ((file (dired-get-filename)) failure)
  707.     (condition-case err
  708.       (load file nil nil t)
  709.       (error (setq failure err)))
  710.     (if (not failure)
  711.     nil
  712.       (dired-log "Load error for %s:\n%s\n" file failure)
  713.       (dired-make-relative file))))
  714.  
  715. ;;;###autoload
  716. (defun dired-do-load (&optional arg)
  717.   "Load the marked (or next ARG) Emacs Lisp files."
  718.   (interactive "P")
  719.   (dired-map-over-marks-check (function dired-load) arg 'load t))
  720.  
  721. ;;;###autoload
  722. (defun dired-do-redisplay (&optional arg test-for-subdir)
  723.   "Redisplay all marked (or next ARG) files.
  724. If on a subdir line, redisplay that subdirectory.  In that case,
  725. a prefix arg lets you edit the `ls' switches used for the new listing."
  726.   ;; Moves point if the next ARG files are redisplayed.
  727.   (interactive "P\np")
  728.   (if (and test-for-subdir (dired-get-subdir))
  729.       (dired-insert-subdir
  730.        (dired-get-subdir)
  731.        (if arg (read-string "Switches for listing: " dired-actual-switches)))
  732.     (message "Redisplaying...")
  733.     ;; message much faster than making dired-map-over-marks show progress
  734.     (dired-uncache
  735.      (if (consp dired-directory) (car dired-directory) dired-directory))
  736.     (dired-map-over-marks (let ((fname (dired-get-filename)))
  737.                 (message "Redisplaying... %s" fname)
  738.                 (dired-update-file-line fname))
  739.               arg)
  740.     (dired-move-to-filename)
  741.     (message "Redisplaying...done")))
  742.  
  743. (defun dired-update-file-line (file)
  744.   ;; Delete the current line, and insert an entry for FILE.
  745.   ;; If FILE is nil, then just delete the current line.
  746.   ;; Keeps any marks that may be present in column one (doing this
  747.   ;; here is faster than with dired-add-entry's optional arg).
  748.   ;; Does not update other dired buffers.  Use dired-relist-entry for that.
  749.   (beginning-of-line)
  750.   (let ((char (following-char)) (opoint (point))
  751.     (buffer-read-only))
  752.     (delete-region (point) (progn (forward-line 1) (point)))
  753.     (if file
  754.     (progn
  755.       (dired-add-entry file)
  756.       ;; Replace space by old marker without moving point.
  757.       ;; Faster than goto+insdel inside a save-excursion?
  758.       (subst-char-in-region opoint (1+ opoint) ?\040 char))))
  759.   (dired-move-to-filename))
  760.  
  761. (defun dired-fun-in-all-buffers (directory fun &rest args)
  762.   ;; In all buffers dired'ing DIRECTORY, run FUN with ARGS.
  763.   ;; Return list of buffers where FUN succeeded (i.e., returned non-nil).
  764.   (let ((buf-list (dired-buffers-for-dir (expand-file-name directory)))
  765.     (obuf (current-buffer))
  766.     buf success-list)
  767.     (while buf-list
  768.       (setq buf (car buf-list)
  769.         buf-list (cdr buf-list))
  770.       (unwind-protect
  771.       (progn
  772.         (set-buffer buf)
  773.         (if (apply fun args)
  774.         (setq success-list (cons (buffer-name buf) success-list))))
  775.     (set-buffer obuf)))
  776.     success-list))
  777.  
  778. ;;;###autoload
  779. (defun dired-add-file (filename &optional marker-char)
  780.   (dired-fun-in-all-buffers
  781.    (file-name-directory filename)
  782.    (function dired-add-entry) filename marker-char))
  783.  
  784. (defun dired-add-entry (filename &optional marker-char)
  785.   ;; Add a new entry for FILENAME, optionally marking it
  786.   ;; with MARKER-CHAR (a character, else dired-marker-char is used).
  787.   ;; Note that this adds the entry `out of order' if files sorted by
  788.   ;; time, etc.
  789.   ;; At least this version inserts in the right subdirectory (if present).
  790.   ;; And it skips "." or ".." (see `dired-trivial-filenames').
  791.   ;; Hidden subdirs are exposed if a file is added there.
  792.   (setq filename (directory-file-name filename))
  793.   ;; Entry is always for files, even if they happen to also be directories
  794.   (let ((opoint (point))
  795.     (cur-dir (dired-current-directory))
  796.     (orig-file-name filename)
  797.     (directory (file-name-directory filename))
  798.     reason)
  799.     (setq filename (file-name-nondirectory filename)
  800.       reason
  801.       (catch 'not-found
  802.         (if (string= directory cur-dir)
  803.         (progn
  804.           (skip-chars-forward "^\r\n")
  805.           (if (eq (following-char) ?\r)
  806.               (dired-unhide-subdir))
  807.           ;; We are already where we should be, except when
  808.           ;; point is before the subdir line or its total line.
  809.           (let ((p (dired-after-subdir-garbage cur-dir)))
  810.             (if (< (point) p)
  811.             (goto-char p))))
  812.           ;; else try to find correct place to insert
  813.           (if (dired-goto-subdir directory)
  814.           (progn;; unhide if necessary
  815.             (if (looking-at "\r");; point is at end of subdir line
  816.             (dired-unhide-subdir))
  817.             ;; found - skip subdir and `total' line
  818.             ;; and uninteresting files like . and ..
  819.             ;; This better not moves into the next subdir!
  820.             (dired-goto-next-nontrivial-file))
  821.         ;; not found
  822.         (throw 'not-found "Subdir not found")))
  823.         (let (buffer-read-only opoint)
  824.           (beginning-of-line)
  825.           (setq opoint (point))
  826.           (dired-add-entry-do-indentation marker-char)
  827.           ;; don't expand `.'.  Show just the file name within directory.
  828.           (let ((default-directory directory))
  829.         (insert-directory filename
  830.                   (concat dired-actual-switches "d")))
  831.           ;; Compensate for a bug in ange-ftp.
  832.           ;; It inserts the file's absolute name, rather than
  833.           ;; the relative one.  That may be hard to fix since it
  834.           ;; is probably controlled by something in ftp.
  835.           (goto-char opoint)    
  836.           (let ((inserted-name (dired-get-filename 'no-dir)))
  837.         (if (file-name-directory inserted-name)
  838.             (progn
  839.               (end-of-line)
  840.               (delete-char (- (length inserted-name)))
  841.               (insert filename)
  842.               (forward-char 1))
  843.           (forward-line 1)))
  844.           ;; Give each line a text property recording info about it.
  845.           (dired-insert-set-properties opoint (point))
  846.           (forward-line -1)
  847.           (if dired-after-readin-hook;; the subdir-alist is not affected...
  848.           (save-excursion;; ...so we can run it right now:
  849.             (save-restriction
  850.               (beginning-of-line)
  851.               (narrow-to-region (point) (save-excursion
  852.                           (forward-line 1) (point)))
  853.               (run-hooks 'dired-after-readin-hook))))
  854.           (dired-move-to-filename))
  855.         ;; return nil if all went well
  856.         nil))
  857.     (if reason                ; don't move away on failure
  858.     (goto-char opoint))
  859.     (not reason)))            ; return t on success, nil else
  860.  
  861. ;; This is a separate function for the sake of nested dired format.
  862. (defun dired-add-entry-do-indentation (marker-char)
  863.   ;; two spaces or a marker plus a space:
  864.   (insert (if marker-char
  865.           (if (integerp marker-char) marker-char dired-marker-char)
  866.         ?\040)
  867.       ?\040))
  868.  
  869. (defun dired-after-subdir-garbage (dir)
  870.   ;; Return pos of first file line of DIR, skipping header and total
  871.   ;; or wildcard lines.
  872.   ;; Important: never moves into the next subdir.
  873.   ;; DIR is assumed to be unhidden.
  874.   ;; Will probably be redefined for VMS etc.
  875.   (save-excursion
  876.     (or (dired-goto-subdir dir) (error "This cannot happen"))
  877.     (forward-line 1)
  878.     (while (and (not (eolp))        ; don't cross subdir boundary
  879.         (not (dired-move-to-filename)))
  880.     (forward-line 1))
  881.     (point)))
  882.  
  883. ;;;###autoload
  884. (defun dired-remove-file (file)
  885.   (dired-fun-in-all-buffers
  886.    (file-name-directory file) (function dired-remove-entry) file))
  887.  
  888. (defun dired-remove-entry (file)
  889.   (save-excursion
  890.     (and (dired-goto-file file)
  891.      (let (buffer-read-only)
  892.        (delete-region (progn (beginning-of-line) (point))
  893.               (save-excursion (forward-line 1) (point)))))))
  894.  
  895. ;;;###autoload
  896. (defun dired-relist-file (file)
  897.   (dired-fun-in-all-buffers (file-name-directory file)
  898.                 (function dired-relist-entry) file))
  899.  
  900. (defun dired-relist-entry (file)
  901.   ;; Relist the line for FILE, or just add it if it did not exist.
  902.   ;; FILE must be an absolute pathname.
  903.   (let (buffer-read-only marker)
  904.     ;; If cursor is already on FILE's line delete-region will cause
  905.     ;; save-excursion to fail because of floating makers,
  906.     ;; moving point to beginning of line.  Sigh.
  907.     (save-excursion
  908.       (and (dired-goto-file file)
  909.        (delete-region (progn (beginning-of-line)
  910.                  (setq marker (following-char))
  911.                  (point))
  912.               (save-excursion (forward-line 1) (point))))
  913.       (setq file (directory-file-name file))
  914.       (dired-add-entry file (if (eq ?\040 marker) nil marker)))))
  915.  
  916. ;;; Copy, move/rename, making hard and symbolic links
  917.  
  918. (defvar dired-backup-overwrite nil
  919.   "*Non-nil if Dired should ask about making backups before overwriting files.
  920. Special value `always' suppresses confirmation.")
  921.  
  922. (defvar dired-overwrite-confirmed)
  923.  
  924. (defun dired-handle-overwrite (to)
  925.   ;; Save old version of a to be overwritten file TO.
  926.   ;; `dired-overwrite-confirmed' and `overwrite-backup-query' are fluid vars
  927.   ;; from dired-create-files.
  928.   (let (backup)
  929.     (if (and dired-backup-overwrite
  930.          dired-overwrite-confirmed
  931.          (setq backup (car (find-backup-file-name to)))
  932.          (or (eq 'always dired-backup-overwrite)
  933.          (dired-query 'overwrite-backup-query
  934.                   (format "Make backup for existing file `%s'? " to))))
  935.     (progn
  936.       (rename-file to backup 0)    ; confirm overwrite of old backup
  937.       (dired-relist-entry backup)))))
  938.  
  939. ;;;###autoload
  940. (defun dired-copy-file (from to ok-flag)
  941.   (dired-handle-overwrite to)
  942.   (copy-file from to ok-flag dired-copy-preserve-time))
  943.  
  944. ;;;###autoload
  945. (defun dired-rename-file (from to ok-flag)
  946.   (dired-handle-overwrite to)
  947.   (rename-file from to ok-flag)        ; error is caught in -create-files
  948.   ;; Silently rename the visited file of any buffer visiting this file.
  949.   (and (get-file-buffer from)
  950.        (save-excursion
  951.      (set-buffer (get-file-buffer from))
  952.      (let ((modflag (buffer-modified-p)))
  953.        (set-visited-file-name to)
  954.        (set-buffer-modified-p modflag))))
  955.   (dired-remove-file from)
  956.   ;; See if it's an inserted subdir, and rename that, too.
  957.   (dired-rename-subdir from to))
  958.  
  959. (defun dired-rename-subdir (from-dir to-dir)
  960.   (setq from-dir (file-name-as-directory from-dir)
  961.     to-dir (file-name-as-directory to-dir))
  962.   (dired-fun-in-all-buffers from-dir
  963.                 (function dired-rename-subdir-1) from-dir to-dir)
  964.   ;; Update visited file name of all affected buffers
  965.   (let ((expanded-from-dir (expand-file-name from-dir))
  966.     (blist (buffer-list)))
  967.     (while blist
  968.       (save-excursion
  969.     (set-buffer (car blist))
  970.     (if (and buffer-file-name
  971.          (dired-in-this-tree buffer-file-name expanded-from-dir))
  972.         (let ((modflag (buffer-modified-p))
  973.           (to-file (dired-replace-in-string
  974.                 (concat "^" (regexp-quote from-dir))
  975.                 to-dir
  976.                 buffer-file-name)))
  977.           (set-visited-file-name to-file)
  978.           (set-buffer-modified-p modflag))))
  979.       (setq blist (cdr blist)))))
  980.  
  981. (defun dired-rename-subdir-1 (dir to)
  982.   ;; Rename DIR to TO in headerlines and dired-subdir-alist, if DIR or
  983.   ;; one of its subdirectories is expanded in this buffer.
  984.   (let ((expanded-dir (expand-file-name dir))
  985.     (alist dired-subdir-alist)
  986.     (elt nil))
  987.     (while alist
  988.       (setq elt (car alist)
  989.         alist (cdr alist))
  990.       (if (dired-in-this-tree (car elt) expanded-dir)
  991.       ;; ELT's subdir is affected by the rename
  992.       (dired-rename-subdir-2 elt dir to)))
  993.     (if (equal dir default-directory)
  994.     ;; if top level directory was renamed, lots of things have to be
  995.     ;; updated:
  996.     (progn
  997.       (dired-unadvertise dir)    ; we no longer dired DIR...
  998.       (setq default-directory to
  999.         dired-directory (expand-file-name;; this is correct
  1000.                  ;; with and without wildcards
  1001.                  (file-name-nondirectory dired-directory)
  1002.                  to))
  1003.       (let ((new-name (file-name-nondirectory
  1004.                (directory-file-name dired-directory))))
  1005.         ;; try to rename buffer, but just leave old name if new
  1006.         ;; name would already exist (don't try appending "<%d>")
  1007.         (or (get-buffer new-name)
  1008.         (rename-buffer new-name)))
  1009.       ;; ... we dired TO now:
  1010.       (dired-advertise)))))
  1011.  
  1012. (defun dired-rename-subdir-2 (elt dir to)
  1013.   ;; Update the headerline and dired-subdir-alist element of directory
  1014.   ;; described by alist-element ELT to reflect the moving of DIR to TO.
  1015.   ;; Thus, ELT describes either DIR itself or a subdir of DIR.
  1016.   (save-excursion
  1017.     (let ((regexp (regexp-quote (directory-file-name dir)))
  1018.       (newtext (directory-file-name to))
  1019.       buffer-read-only)
  1020.       (goto-char (dired-get-subdir-min elt))
  1021.       ;; Update subdir headerline in buffer
  1022.       (if (not (looking-at dired-subdir-regexp))
  1023.       (error "%s not found where expected - dired-subdir-alist broken?"
  1024.          dir)
  1025.     (goto-char (match-beginning 1))
  1026.     (if (re-search-forward regexp (match-end 1) t)
  1027.         (replace-match newtext t t)
  1028.       (error "Expected to find `%s' in headerline of %s" dir (car elt))))
  1029.       ;; Update buffer-local dired-subdir-alist
  1030.       (setcar elt
  1031.           (dired-normalize-subdir
  1032.            (dired-replace-in-string regexp newtext (car elt)))))))
  1033.  
  1034. ;; The basic function for half a dozen variations on cp/mv/ln/ln -s.
  1035. (defun dired-create-files (file-creator operation fn-list name-constructor
  1036.                     &optional marker-char)
  1037.  
  1038. ;; Create a new file for each from a list of existing files.  The user
  1039. ;; is queried, dired buffers are updated, and at the end a success or
  1040. ;; failure message is displayed
  1041.  
  1042. ;; FILE-CREATOR must accept three args: oldfile newfile ok-if-already-exists
  1043.  
  1044. ;; It is called for each file and must create newfile, the entry of
  1045. ;; which will be added.  The user will be queried if the file already
  1046. ;; exists.  If oldfile is removed by FILE-CREATOR (i.e, it is a
  1047. ;; rename), it is FILE-CREATOR's responsibility to update dired
  1048. ;; buffers.  FILE-CREATOR must abort by signaling a file-error if it
  1049. ;; could not create newfile.  The error is caught and logged.
  1050.  
  1051. ;; OPERATION (a capitalized string, e.g. `Copy') describes the
  1052. ;; operation performed.  It is used for error logging.
  1053.  
  1054. ;; FN-LIST is the list of files to copy (full absolute pathnames).
  1055.  
  1056. ;; NAME-CONSTRUCTOR returns a newfile for every oldfile, or nil to
  1057. ;; skip.  If it skips files for other reasons than a direct user
  1058. ;; query, it is supposed to tell why (using dired-log).
  1059.  
  1060. ;; Optional MARKER-CHAR is a character with which to mark every
  1061. ;; newfile's entry, or t to use the current marker character if the
  1062. ;; oldfile was marked.
  1063.  
  1064.   (let (failures skipped (success-count 0) (total (length fn-list)))
  1065.     (let (to overwrite-query
  1066.          overwrite-backup-query)    ; for dired-handle-overwrite
  1067.       (mapcar
  1068.        (function
  1069.     (lambda (from)
  1070.       (setq to (funcall name-constructor from))
  1071.       (if (equal to from)
  1072.           (progn
  1073.         (setq to nil)
  1074.         (dired-log "Cannot %s to same file: %s\n"
  1075.                (downcase operation) from)))
  1076.       (if (not to)
  1077.           (setq skipped (cons (dired-make-relative from) skipped))
  1078.         (let* ((overwrite (file-exists-p to))
  1079.            (dired-overwrite-confirmed    ; for dired-handle-overwrite
  1080.             (and overwrite
  1081.              (let ((help-form '(format "\
  1082. Type SPC or `y' to overwrite file `%s',
  1083. DEL or `n' to skip to next,
  1084. ESC or `q' to not overwrite any of the remaining files,
  1085. `!' to overwrite all remaining files with no more questions." to)))
  1086.                (dired-query 'overwrite-query
  1087.                     "Overwrite `%s'?" to))))
  1088.            ;; must determine if FROM is marked before file-creator
  1089.            ;; gets a chance to delete it (in case of a move).
  1090.            (actual-marker-char
  1091.             (cond  ((integerp marker-char) marker-char)
  1092.                (marker-char (dired-file-marker from)) ; slow
  1093.                (t nil))))
  1094.           (condition-case err
  1095.           (progn
  1096.             (funcall file-creator from to dired-overwrite-confirmed)
  1097.             (if overwrite
  1098.             ;; If we get here, file-creator hasn't been aborted
  1099.             ;; and the old entry (if any) has to be deleted
  1100.             ;; before adding the new entry.
  1101.             (dired-remove-file to))
  1102.             (setq success-count (1+ success-count))
  1103.             (message "%s: %d of %d" operation success-count total)
  1104.             (dired-add-file to actual-marker-char))
  1105.         (file-error        ; FILE-CREATOR aborted
  1106.          (progn
  1107.            (setq failures (cons (dired-make-relative from) failures))
  1108.            (dired-log "%s `%s' to `%s' failed:\n%s\n"
  1109.                   operation from to err))))))))
  1110.        fn-list))
  1111.     (cond
  1112.      (failures
  1113.       (dired-log-summary
  1114.        (format "%s failed for %d of %d file%s"
  1115.         operation (length failures) total
  1116.         (dired-plural-s total))
  1117.        failures))
  1118.      (skipped
  1119.       (dired-log-summary
  1120.        (format "%s: %d of %d file%s skipped"
  1121.         operation (length skipped) total
  1122.         (dired-plural-s total))
  1123.        skipped))
  1124.      (t
  1125.       (message "%s: %s file%s"
  1126.            operation success-count (dired-plural-s success-count)))))
  1127.   (dired-move-to-filename))
  1128.  
  1129. (defun dired-do-create-files (op-symbol file-creator operation arg
  1130.                          &optional marker-char op1
  1131.                          how-to)
  1132.   ;; Create a new file for each marked file.
  1133.   ;; Prompts user for target, which is a directory in which to create
  1134.   ;;   the new files.  Target may be a plain file if only one marked
  1135.   ;;   file exists.
  1136.   ;; OP-SYMBOL is the symbol for the operation.  Function `dired-mark-pop-up'
  1137.   ;;   will determine whether pop-ups are appropriate for this OP-SYMBOL.
  1138.   ;; FILE-CREATOR and OPERATION as in dired-create-files.
  1139.   ;; ARG as in dired-get-marked-files.
  1140.   ;; Optional arg OP1 is an alternate form for OPERATION if there is
  1141.   ;;   only one file.
  1142.   ;; Optional arg MARKER-CHAR as in dired-create-files.
  1143.   ;; Optional arg HOW-TO determines how to treat target:
  1144.   ;;   If HOW-TO is not given (or nil), and target is a directory, the
  1145.   ;;     file(s) are created inside the target directory.  If target
  1146.   ;;     is not a directory, there must be exactly one marked file,
  1147.   ;;     else error.
  1148.   ;;   If HOW-TO is t, then target is not modified.  There must be
  1149.   ;;     exactly one marked file, else error.
  1150.   ;; Else HOW-TO is assumed to be a function of one argument, target,
  1151.   ;;     that looks at target and returns a value for the into-dir
  1152.   ;;     variable.  The function dired-into-dir-with-symlinks is provided
  1153.   ;;     for the case (common when creating symlinks) that symbolic
  1154.   ;;     links to directories are not to be considered as directories
  1155.   ;;     (as file-directory-p would if HOW-TO had been nil).
  1156.   (or op1 (setq op1 operation))
  1157.   (let* ((fn-list (dired-get-marked-files nil arg))
  1158.      (fn-count (length fn-list))
  1159.      (target (expand-file-name
  1160.            (dired-mark-read-file-name
  1161.             (concat (if (= 1 fn-count) op1 operation) " %s to: ")
  1162.             (dired-dwim-target-directory)
  1163.             op-symbol arg (mapcar (function dired-make-relative) fn-list))))
  1164.      (into-dir (cond ((null how-to) (file-directory-p target))
  1165.              ((eq how-to t) nil)
  1166.              (t (funcall how-to target)))))
  1167.     (if (and (> fn-count 1)
  1168.          (not into-dir))
  1169.     (error "Marked %s: target must be a directory: %s" operation target))
  1170.     ;; rename-file bombs when moving directories unless we do this:
  1171.     (or into-dir (setq target (directory-file-name target)))
  1172.     (dired-create-files
  1173.      file-creator operation fn-list
  1174.      (if into-dir            ; target is a directory
  1175.      ;; This function uses fluid vars into-dir and target when called
  1176.      ;; inside dired-create-files:
  1177.      (function (lambda (from)
  1178.              (expand-file-name (file-name-nondirectory from) target)))
  1179.        (function (lambda (from) target)))
  1180.      marker-char)))
  1181.  
  1182. ;; Read arguments for a marked-files command that wants a file name,
  1183. ;; perhaps popping up the list of marked files.
  1184. ;; ARG is the prefix arg and indicates whether the files came from
  1185. ;; marks (ARG=nil) or a repeat factor (integerp ARG).
  1186. ;; If the current file was used, the list has but one element and ARG
  1187. ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
  1188.  
  1189. (defun dired-mark-read-file-name (prompt dir op-symbol arg files)
  1190.   (dired-mark-pop-up
  1191.    nil op-symbol files
  1192.    (function read-file-name)
  1193.    (format prompt (dired-mark-prompt arg files)) dir))
  1194.  
  1195. (defun dired-dwim-target-directory ()
  1196.   ;; Try to guess which target directory the user may want.
  1197.   ;; If there is a dired buffer displayed in the next window, use
  1198.   ;; its current subdir, else use current subdir of this dired buffer.
  1199.   (let ((this-dir (and (eq major-mode 'dired-mode)
  1200.                (dired-current-directory))))
  1201.     ;; non-dired buffer may want to profit from this function, e.g. vm-uudecode
  1202.     (if dired-dwim-target
  1203.     (let* ((other-buf (window-buffer (next-window)))
  1204.            (other-dir (save-excursion
  1205.                 (set-buffer other-buf)
  1206.                 (and (eq major-mode 'dired-mode)
  1207.                  (dired-current-directory)))))
  1208.       (or other-dir this-dir))
  1209.       this-dir)))
  1210.  
  1211. ;;;###autoload
  1212. (defun dired-create-directory (directory)
  1213.   "Create a directory called DIRECTORY."
  1214.   (interactive
  1215.    (list (read-file-name "Create directory: " (dired-current-directory))))
  1216.   (let ((expanded (directory-file-name (expand-file-name directory))))
  1217.     (make-directory expanded)
  1218.     (dired-add-file expanded)
  1219.     (dired-move-to-filename)))
  1220.  
  1221. (defun dired-into-dir-with-symlinks (target)
  1222.   (and (file-directory-p target)
  1223.        (not (file-symlink-p target))))
  1224. ;; This may not always be what you want, especially if target is your
  1225. ;; home directory and it happens to be a symbolic link, as is often the
  1226. ;; case with NFS and automounters.  Or if you want to make symlinks
  1227. ;; into directories that themselves are only symlinks, also quite
  1228. ;; common.
  1229.  
  1230. ;; So we don't use this function as value for HOW-TO in
  1231. ;; dired-do-symlink, which has the minor disadvantage of
  1232. ;; making links *into* a symlinked-dir, when you really wanted to
  1233. ;; *overwrite* that symlink.  In that (rare, I guess) case, you'll
  1234. ;; just have to remove that symlink by hand before making your marked
  1235. ;; symlinks.
  1236.  
  1237. ;;;###autoload
  1238. (defun dired-do-copy (&optional arg)
  1239.   "Copy all marked (or next ARG) files, or copy the current file.
  1240. This normally preserves the last-modified date when copying.
  1241. When operating on just the current file, you specify the new name.
  1242. When operating on multiple or marked files, you specify a directory,
  1243. and new copies of these files are made in that directory
  1244. with the same names that the files currently have."
  1245.   (interactive "P")
  1246.   (dired-do-create-files 'copy (function dired-copy-file)
  1247.                (if dired-copy-preserve-time "Copy [-p]" "Copy")
  1248.                arg dired-keep-marker-copy))
  1249.  
  1250. ;;;###autoload
  1251. (defun dired-do-symlink (&optional arg)
  1252.   "Make symbolic links to current file or all marked (or next ARG) files.
  1253. When operating on just the current file, you specify the new name.
  1254. When operating on multiple or marked files, you specify a directory
  1255. and new symbolic links are made in that directory
  1256. with the same names that the files currently have."
  1257.   (interactive "P")
  1258.   (dired-do-create-files 'symlink (function make-symbolic-link)
  1259.                "Symlink" arg dired-keep-marker-symlink))
  1260.  
  1261. ;;;###autoload
  1262. (defun dired-do-hardlink (&optional arg)
  1263.   "Add names (hard links) current file or all marked (or next ARG) files.
  1264. When operating on just the current file, you specify the new name.
  1265. When operating on multiple or marked files, you specify a directory
  1266. and new hard links are made in that directory
  1267. with the same names that the files currently have."
  1268.   (interactive "P")
  1269.   (dired-do-create-files 'hardlink (function add-name-to-file)
  1270.                "Hardlink" arg dired-keep-marker-hardlink))
  1271.  
  1272. ;;;###autoload
  1273. (defun dired-do-rename (&optional arg)
  1274.   "Rename current file or all marked (or next ARG) files.
  1275. When renaming just the current file, you specify the new name.
  1276. When renaming multiple or marked files, you specify a directory."
  1277.   (interactive "P")
  1278.   (dired-do-create-files 'move (function dired-rename-file)
  1279.              "Move" arg dired-keep-marker-rename "Rename"))
  1280. ;;;###end dired-cp.el
  1281.  
  1282. ;;; 5K
  1283. ;;;###begin dired-re.el
  1284. (defun dired-do-create-files-regexp
  1285.   (file-creator operation arg regexp newname &optional whole-path marker-char)
  1286.   ;; Create a new file for each marked file using regexps.
  1287.   ;; FILE-CREATOR and OPERATION as in dired-create-files.
  1288.   ;; ARG as in dired-get-marked-files.
  1289.   ;; Matches each marked file against REGEXP and constructs the new
  1290.   ;;   filename from NEWNAME (like in function replace-match).
  1291.   ;; Optional arg WHOLE-PATH means match/replace the whole pathname
  1292.   ;;   instead of only the non-directory part of the file.
  1293.   ;; Optional arg MARKER-CHAR as in dired-create-files.
  1294.   (let* ((fn-list (dired-get-marked-files nil arg))
  1295.      (fn-count (length fn-list))
  1296.      (operation-prompt (concat operation " `%s' to `%s'?"))
  1297.      (rename-regexp-help-form (format "\
  1298. Type SPC or `y' to %s one match, DEL or `n' to skip to next,
  1299. `!' to %s all remaining matches with no more questions."
  1300.                       (downcase operation)
  1301.                       (downcase operation)))
  1302.      (regexp-name-constructor
  1303.       ;; Function to construct new filename using REGEXP and NEWNAME:
  1304.       (if whole-path        ; easy (but rare) case
  1305.           (function
  1306.            (lambda (from)
  1307.          (let ((to (dired-string-replace-match regexp from newname))
  1308.                ;; must bind help-form directly around call to
  1309.                ;; dired-query
  1310.                (help-form rename-regexp-help-form))
  1311.            (if to
  1312.                (and (dired-query 'rename-regexp-query
  1313.                      operation-prompt
  1314.                      from
  1315.                      to)
  1316.                 to)
  1317.              (dired-log "%s: %s did not match regexp %s\n"
  1318.                 operation from regexp)))))
  1319.         ;; not whole-path, replace non-directory part only
  1320.         (function
  1321.          (lambda (from)
  1322.            (let* ((new (dired-string-replace-match
  1323.                 regexp (file-name-nondirectory from) newname))
  1324.               (to (and new    ; nil means there was no match
  1325.                    (expand-file-name new
  1326.                          (file-name-directory from))))
  1327.               (help-form rename-regexp-help-form))
  1328.          (if to
  1329.              (and (dired-query 'rename-regexp-query
  1330.                        operation-prompt
  1331.                        (dired-make-relative from)
  1332.                        (dired-make-relative to))
  1333.               to)
  1334.            (dired-log "%s: %s did not match regexp %s\n"
  1335.                   operation (file-name-nondirectory from) regexp)))))))
  1336.      rename-regexp-query)
  1337.     (dired-create-files
  1338.      file-creator operation fn-list regexp-name-constructor marker-char)))
  1339.  
  1340. (defun dired-mark-read-regexp (operation)
  1341.   ;; Prompt user about performing OPERATION.
  1342.   ;; Read and return list of: regexp newname arg whole-path.
  1343.   (let* ((whole-path
  1344.       (equal 0 (prefix-numeric-value current-prefix-arg)))
  1345.      (arg
  1346.       (if whole-path nil current-prefix-arg))
  1347.      (regexp
  1348.       (dired-read-regexp
  1349.        (concat (if whole-path "Path " "") operation " from (regexp): ")))
  1350.      (newname
  1351.       (read-string
  1352.        (concat (if whole-path "Path " "") operation " " regexp " to: "))))
  1353.     (list regexp newname arg whole-path)))
  1354.  
  1355. ;;;###autoload
  1356. (defun dired-do-rename-regexp (regexp newname &optional arg whole-path)
  1357.   "Rename marked files containing REGEXP to NEWNAME.
  1358. As each match is found, the user must type a character saying
  1359.   what to do with it.  For directions, type \\[help-command] at that time.
  1360. NEWNAME may contain \\=\\<n> or \\& as in `query-replace-regexp'.
  1361. REGEXP defaults to the last regexp used.
  1362. With a zero prefix arg, renaming by regexp affects the complete
  1363.   pathname - usually only the non-directory part of file names is used
  1364.   and changed."
  1365.   (interactive (dired-mark-read-regexp "Rename"))
  1366.   (dired-do-create-files-regexp
  1367.    (function dired-rename-file)
  1368.    "Rename" arg regexp newname whole-path dired-keep-marker-rename))
  1369.  
  1370. ;;;###autoload
  1371. (defun dired-do-copy-regexp (regexp newname &optional arg whole-path)
  1372.   "Copy all marked files containing REGEXP to NEWNAME.
  1373. See function `dired-rename-regexp' for more info."
  1374.   (interactive (dired-mark-read-regexp "Copy"))
  1375.   (dired-do-create-files-regexp
  1376.    (function dired-copy-file)
  1377.    (if dired-copy-preserve-time "Copy [-p]" "Copy")
  1378.    arg regexp newname whole-path dired-keep-marker-copy))
  1379.  
  1380. ;;;###autoload
  1381. (defun dired-do-hardlink-regexp (regexp newname &optional arg whole-path)
  1382.   "Hardlink all marked files containing REGEXP to NEWNAME.
  1383. See function `dired-rename-regexp' for more info."
  1384.   (interactive (dired-mark-read-regexp "HardLink"))
  1385.   (dired-do-create-files-regexp
  1386.    (function add-name-to-file)
  1387.    "HardLink" arg regexp newname whole-path dired-keep-marker-hardlink))
  1388.  
  1389. ;;;###autoload
  1390. (defun dired-do-symlink-regexp (regexp newname &optional arg whole-path)
  1391.   "Symlink all marked files containing REGEXP to NEWNAME.
  1392. See function `dired-rename-regexp' for more info."
  1393.   (interactive (dired-mark-read-regexp "SymLink"))
  1394.   (dired-do-create-files-regexp
  1395.    (function make-symbolic-link)
  1396.    "SymLink" arg regexp newname whole-path dired-keep-marker-symlink))
  1397.  
  1398. (defun dired-create-files-non-directory
  1399.   (file-creator basename-constructor operation arg)
  1400.   ;; Perform FILE-CREATOR on the non-directory part of marked files
  1401.   ;; using function BASENAME-CONSTRUCTOR, with query for each file.
  1402.   ;; OPERATION like in dired-create-files, ARG as in dired-get-marked-files.
  1403.   (let (rename-non-directory-query)
  1404.     (dired-create-files
  1405.      file-creator
  1406.      operation
  1407.      (dired-get-marked-files nil arg)
  1408.      (function
  1409.       (lambda (from)
  1410.     (let ((to (concat (file-name-directory from)
  1411.               (funcall basename-constructor
  1412.                    (file-name-nondirectory from)))))
  1413.       (and (let ((help-form (format "\
  1414. Type SPC or `y' to %s one file, DEL or `n' to skip to next,
  1415. `!' to %s all remaining matches with no more questions."
  1416.                     (downcase operation)
  1417.                     (downcase operation))))
  1418.          (dired-query 'rename-non-directory-query
  1419.                   (concat operation " `%s' to `%s'")
  1420.                   (dired-make-relative from)
  1421.                   (dired-make-relative to)))
  1422.            to))))
  1423.      dired-keep-marker-rename)))
  1424.  
  1425. (defun dired-rename-non-directory (basename-constructor operation arg)
  1426.   (dired-create-files-non-directory
  1427.    (function dired-rename-file)
  1428.    basename-constructor operation arg))
  1429.  
  1430. ;;;###autoload
  1431. (defun dired-upcase (&optional arg)
  1432.   "Rename all marked (or next ARG) files to upper case."
  1433.   (interactive "P")
  1434.   (dired-rename-non-directory (function upcase) "Rename upcase" arg))
  1435.  
  1436. ;;;###autoload
  1437. (defun dired-downcase (&optional arg)
  1438.   "Rename all marked (or next ARG) files to lower case."
  1439.   (interactive "P")
  1440.   (dired-rename-non-directory (function downcase) "Rename downcase" arg))
  1441.  
  1442. ;;;###end dired-re.el
  1443.  
  1444. ;;; 13K
  1445. ;;;###begin dired-ins.el
  1446.  
  1447. ;;;###autoload
  1448. (defun dired-maybe-insert-subdir (dirname &optional
  1449.                       switches no-error-if-not-dir-p)
  1450.   "Insert this subdirectory into the same dired buffer.
  1451. If it is already present, just move to it (type \\[dired-do-redisplay] to refresh),
  1452.   else inserts it at its natural place (as `ls -lR' would have done).
  1453. With a prefix arg, you may edit the ls switches used for this listing.
  1454.   You can add `R' to the switches to expand the whole tree starting at
  1455.   this subdirectory.
  1456. This function takes some pains to conform to `ls -lR' output."
  1457.   (interactive
  1458.    (list (dired-get-filename)
  1459.      (if current-prefix-arg
  1460.          (read-string "Switches for listing: " dired-actual-switches))))
  1461.   (let ((opoint (point)))
  1462.     ;; We don't need a marker for opoint as the subdir is always
  1463.     ;; inserted *after* opoint.
  1464.     (setq dirname (file-name-as-directory dirname))
  1465.     (or (and (not switches)
  1466.          (dired-goto-subdir dirname))
  1467.     (dired-insert-subdir dirname switches no-error-if-not-dir-p))
  1468.     ;; Push mark so that it's easy to find back.  Do this after the
  1469.     ;; insert message so that the user sees the `Mark set' message.
  1470.     (push-mark opoint)))
  1471.  
  1472. (defun dired-insert-subdir (dirname &optional switches no-error-if-not-dir-p)
  1473.   "Insert this subdirectory into the same dired buffer.
  1474. If it is already present, overwrites previous entry,
  1475.   else inserts it at its natural place (as `ls -lR' would have done).
  1476. With a prefix arg, you may edit the `ls' switches used for this listing.
  1477.   You can add `R' to the switches to expand the whole tree starting at
  1478.   this subdirectory.
  1479. This function takes some pains to conform to `ls -lR' output."
  1480.   ;; NO-ERROR-IF-NOT-DIR-P needed for special filesystems like
  1481.   ;; Prospero where dired-ls does the right thing, but
  1482.   ;; file-directory-p has not been redefined.
  1483.   (interactive
  1484.    (list (dired-get-filename)
  1485.      (if current-prefix-arg
  1486.          (read-string "Switches for listing: " dired-actual-switches))))
  1487.   (setq dirname (file-name-as-directory (expand-file-name dirname)))
  1488.   (dired-insert-subdir-validate dirname switches)
  1489.   (or no-error-if-not-dir-p
  1490.       (file-directory-p dirname)
  1491.       (error  "Attempt to insert a non-directory: %s" dirname))
  1492.   (let ((elt (assoc dirname dired-subdir-alist))
  1493.      switches-have-R mark-alist case-fold-search buffer-read-only)
  1494.     ;; case-fold-search is nil now, so we can test for capital `R':
  1495.     (if (setq switches-have-R (and switches (string-match "R" switches)))
  1496.     ;; avoid duplicated subdirs
  1497.     (setq mark-alist (dired-kill-tree dirname t)))
  1498.     (if elt
  1499.     ;; If subdir is already present, remove it and remember its marks
  1500.     (setq mark-alist (nconc (dired-insert-subdir-del elt) mark-alist))
  1501.       (dired-insert-subdir-newpos dirname)) ; else compute new position
  1502.     (dired-insert-subdir-doupdate
  1503.      dirname elt (dired-insert-subdir-doinsert dirname switches))
  1504.     (if switches-have-R (dired-build-subdir-alist))
  1505.     (dired-initial-position dirname)
  1506.     (save-excursion (dired-mark-remembered mark-alist))))
  1507.  
  1508. ;; This is a separate function for dired-vms.
  1509. (defun dired-insert-subdir-validate (dirname &optional switches)
  1510.   ;; Check that it is valid to insert DIRNAME with SWITCHES.
  1511.   ;; Signal an error if invalid (e.g. user typed `i' on `..').
  1512.   (or (dired-in-this-tree dirname (expand-file-name default-directory))
  1513.       (error  "%s: not in this directory tree" dirname))
  1514.   (if switches
  1515.       (let (case-fold-search)
  1516.     (mapcar
  1517.      (function
  1518.       (lambda (x)
  1519.         (or (eq (null (string-match x switches))
  1520.             (null (string-match x dired-actual-switches)))
  1521.         (error "Can't have dirs with and without -%s switches together"
  1522.                x))))
  1523.      ;; all switches that make a difference to dired-get-filename:
  1524.      '("F" "b")))))
  1525.  
  1526. (defun dired-alist-add (dir new-marker)
  1527.   ;; Add new DIR at NEW-MARKER.  Sort alist.
  1528.   (dired-alist-add-1 dir new-marker)
  1529.   (dired-alist-sort))
  1530.  
  1531. (defun dired-alist-sort ()
  1532.   ;; Keep the alist sorted on buffer position.
  1533.   (setq dired-subdir-alist
  1534.     (sort dired-subdir-alist
  1535.           (function (lambda (elt1 elt2)
  1536.               (> (dired-get-subdir-min elt1)
  1537.                  (dired-get-subdir-min elt2)))))))
  1538.  
  1539. (defun dired-kill-tree (dirname &optional remember-marks)
  1540.   ;;"Kill all proper subdirs of DIRNAME, excluding DIRNAME itself.
  1541.   ;; With optional arg REMEMBER-MARKS, return an alist of marked files."
  1542.   (interactive "DKill tree below directory: ")
  1543.   (setq dirname (expand-file-name dirname))
  1544.   (let ((s-alist dired-subdir-alist) dir m-alist)
  1545.     (while s-alist
  1546.       (setq dir (car (car s-alist))
  1547.         s-alist (cdr s-alist))
  1548.       (if (and (not (string-equal dir dirname))
  1549.            (dired-in-this-tree dir dirname)
  1550.            (dired-goto-subdir dir))
  1551.       (setq m-alist (nconc (dired-kill-subdir remember-marks) m-alist))))
  1552.     m-alist))
  1553.  
  1554. (defun dired-insert-subdir-newpos (new-dir)
  1555.   ;; Find pos for new subdir, according to tree order.
  1556.   ;;(goto-char (point-max))
  1557.   (let ((alist dired-subdir-alist) elt dir pos new-pos)
  1558.     (while alist
  1559.       (setq elt (car alist)
  1560.         alist (cdr alist)
  1561.         dir (car elt)
  1562.         pos (dired-get-subdir-min elt))
  1563.       (if (dired-tree-lessp dir new-dir)
  1564.       ;; Insert NEW-DIR after DIR
  1565.       (setq new-pos (dired-get-subdir-max elt)
  1566.         alist nil)))
  1567.     (goto-char new-pos))
  1568.   ;; want a separating newline between subdirs
  1569.   (or (eobp)
  1570.       (forward-line -1))
  1571.   (insert "\n")
  1572.   (point))
  1573.  
  1574. (defun dired-insert-subdir-del (element)
  1575.   ;; Erase an already present subdir (given by ELEMENT) from buffer.
  1576.   ;; Move to that buffer position.  Return a mark-alist.
  1577.   (let ((begin-marker (dired-get-subdir-min element)))
  1578.     (goto-char begin-marker)
  1579.     ;; Are at beginning of subdir (and inside it!).  Now determine its end:
  1580.     (goto-char (dired-subdir-max))
  1581.     (or (eobp);; want a separating newline _between_ subdirs:
  1582.     (forward-char -1))
  1583.     (prog1
  1584.     (dired-remember-marks begin-marker (point))
  1585.       (delete-region begin-marker (point)))))
  1586.  
  1587. (defun dired-insert-subdir-doinsert (dirname switches)
  1588.   ;; Insert ls output after point and put point on the correct
  1589.   ;; position for the subdir alist.
  1590.   ;; Return the boundary of the inserted text (as list of BEG and END).
  1591.   (let ((begin (point)) end)
  1592.     (message "Reading directory %s..." dirname)
  1593.     (let ((dired-actual-switches
  1594.        (or switches
  1595.            (dired-replace-in-string "R" "" dired-actual-switches))))
  1596.       (if (equal dirname (car (car (reverse dired-subdir-alist))))
  1597.       ;; top level directory may contain wildcards:
  1598.       (dired-readin-insert dired-directory)
  1599.     (let ((opoint (point)))
  1600.       (insert-directory dirname dired-actual-switches nil t)
  1601.       (dired-insert-set-properties opoint (point)))))
  1602.     (message "Reading directory %s...done" dirname)
  1603.     (setq end (point-marker))
  1604.     (indent-rigidly begin end 2)
  1605.     ;;  call dired-insert-headerline afterwards, as under VMS dired-ls
  1606.     ;;  does insert the headerline itself and the insert function just
  1607.     ;;  moves point.
  1608.     ;;  Need a marker for END as this inserts text.
  1609.     (goto-char begin)
  1610.     (dired-insert-headerline dirname)
  1611.     ;; point is now like in dired-build-subdir-alist
  1612.     (prog1
  1613.     (list begin (marker-position end))
  1614.       (set-marker end nil))))
  1615.  
  1616. (defun dired-insert-subdir-doupdate (dirname elt beg-end)
  1617.   ;; Point is at the correct subdir alist position for ELT,
  1618.   ;; BEG-END is the subdir-region (as list of begin and end).
  1619.   (if elt                ; subdir was already present
  1620.       ;; update its position (should actually be unchanged)
  1621.       (set-marker (dired-get-subdir-min elt) (point-marker))
  1622.     (dired-alist-add dirname (point-marker)))
  1623.   ;; The hook may depend on the subdir-alist containing the just
  1624.   ;; inserted subdir, so run it after dired-alist-add:
  1625.   (if dired-after-readin-hook
  1626.       (save-excursion
  1627.     (let ((begin (nth 0 beg-end))
  1628.           (end (nth 1 beg-end)))
  1629.       (goto-char begin)
  1630.       (save-restriction
  1631.         (narrow-to-region begin end)
  1632.         ;; hook may add or delete lines, but the subdir boundary
  1633.         ;; marker floats
  1634.         (run-hooks 'dired-after-readin-hook))))))
  1635.  
  1636. (defun dired-tree-lessp (dir1 dir2)
  1637.   ;; Lexicographic order on pathname components, like `ls -lR':
  1638.   ;; DIR1 < DIR2 iff DIR1 comes *before* DIR2 in an `ls -lR' listing,
  1639.   ;;   i.e., iff DIR1 is a (grand)parent dir of DIR2,
  1640.   ;;   or DIR1 and DIR2 are in the same parentdir and their last
  1641.   ;;   components are string-lessp.
  1642.   ;; Thus ("/usr/" "/usr/bin") and ("/usr/a/" "/usr/b/") are tree-lessp.
  1643.   ;; string-lessp could arguably be replaced by file-newer-than-file-p
  1644.   ;;   if dired-actual-switches contained `t'.
  1645.   (setq dir1 (file-name-as-directory dir1)
  1646.     dir2 (file-name-as-directory dir2))
  1647.   (let ((components-1 (dired-split "/" dir1))
  1648.     (components-2 (dired-split "/" dir2)))
  1649.     (while (and components-1
  1650.         components-2
  1651.         (equal (car components-1) (car components-2)))
  1652.       (setq components-1 (cdr components-1)
  1653.         components-2 (cdr components-2)))
  1654.     (let ((c1 (car components-1))
  1655.       (c2 (car components-2)))
  1656.  
  1657.       (cond ((and c1 c2)
  1658.          (string-lessp c1 c2))
  1659.         ((and (null c1) (null c2))
  1660.          nil)            ; they are equal, not lessp
  1661.         ((null c1)            ; c2 is a subdir of c1: c1<c2
  1662.          t)
  1663.         ((null c2)            ; c1 is a subdir of c2: c1>c2
  1664.          nil)
  1665.         (t (error "This can't happen"))))))
  1666.  
  1667. ;; There should be a builtin split function - inverse to mapconcat.
  1668. (defun dired-split (pat str &optional limit)
  1669.   "Splitting on regexp PAT, turn string STR into a list of substrings.
  1670. Optional third arg LIMIT (>= 1) is a limit to the length of the
  1671. resulting list.
  1672. Thus, if SEP is a regexp that only matches itself,
  1673.  
  1674.    (mapconcat 'identity (dired-split SEP STRING) SEP)
  1675.  
  1676. is always equal to STRING."
  1677.   (let* ((start (string-match pat str))
  1678.      (result (list (substring str 0 start)))
  1679.      (count 1)
  1680.      (end (if start (match-end 0))))
  1681.     (if end                ; else nothing left
  1682.     (while (and (or (not (integerp limit))
  1683.             (< count limit))
  1684.             (string-match pat str end))
  1685.       (setq start (match-beginning 0)
  1686.         count (1+ count)
  1687.         result (cons (substring str end start) result)
  1688.         end (match-end 0)
  1689.         start end)
  1690.       ))
  1691.     (if (and (or (not (integerp limit))
  1692.          (< count limit))
  1693.          end)            ; else nothing left
  1694.     (setq result
  1695.           (cons (substring str end) result)))
  1696.     (nreverse result)))
  1697.  
  1698. ;;; moving by subdirectories
  1699.  
  1700. ;;;###autoload
  1701. (defun dired-prev-subdir (arg &optional no-error-if-not-found no-skip)
  1702.   "Go to previous subdirectory, regardless of level.
  1703. When called interactively and not on a subdir line, go to this subdir's line."
  1704.   ;;(interactive "p")
  1705.   (interactive
  1706.    (list (if current-prefix-arg
  1707.          (prefix-numeric-value current-prefix-arg)
  1708.        ;; if on subdir start already, don't stay there!
  1709.        (if (dired-get-subdir) 1 0))))
  1710.   (dired-next-subdir (- arg) no-error-if-not-found no-skip))
  1711.  
  1712. (defun dired-subdir-min ()
  1713.   (save-excursion
  1714.     (if (not (dired-prev-subdir 0 t t))
  1715.     (error "Not in a subdir!")
  1716.       (point))))
  1717.  
  1718. ;;;###autoload
  1719. (defun dired-goto-subdir (dir)
  1720.   "Go to end of header line of DIR in this dired buffer.
  1721. Return value of point on success, otherwise return nil.
  1722. The next char is either \\n, or \\r if DIR is hidden."
  1723.   (interactive
  1724.    (prog1                ; let push-mark display its message
  1725.        (list (expand-file-name
  1726.           (completing-read "Goto in situ directory: " ; prompt
  1727.                    dired-subdir-alist ; table
  1728.                    nil    ; predicate
  1729.                    t    ; require-match
  1730.                    (dired-current-directory))))
  1731.      (push-mark)))
  1732.   (setq dir (file-name-as-directory dir))
  1733.   (let ((elt (assoc dir dired-subdir-alist)))
  1734.     (and elt
  1735.      (goto-char (dired-get-subdir-min elt))
  1736.      ;; dired-subdir-hidden-p and dired-add-entry depend on point being
  1737.      ;; at either \r or \n after this function succeeds.
  1738.      (progn (skip-chars-forward "^\r\n")
  1739.         (point)))))
  1740.  
  1741. ;;;###autoload
  1742. (defun dired-mark-subdir-files ()
  1743.   "Mark all files except `.' and `..'."
  1744.   (interactive)
  1745.   (let ((p-min (dired-subdir-min)))
  1746.     (dired-mark-files-in-region p-min (dired-subdir-max))))
  1747.  
  1748. ;;;###autoload
  1749. (defun dired-kill-subdir (&optional remember-marks)
  1750.   "Remove all lines of current subdirectory.
  1751. Lower levels are unaffected."
  1752.   ;; With optional REMEMBER-MARKS, return a mark-alist.
  1753.   (interactive)
  1754.   (let ((beg (dired-subdir-min))
  1755.     (end (dired-subdir-max))
  1756.     buffer-read-only cur-dir)
  1757.     (setq cur-dir (dired-current-directory))
  1758.     (if (equal cur-dir default-directory)
  1759.     (error "Attempt to kill top level directory"))
  1760.     (prog1
  1761.     (if remember-marks (dired-remember-marks beg end))
  1762.       (delete-region beg end)
  1763.       (if (eobp)            ; don't leave final blank line
  1764.       (delete-char -1))
  1765.       (dired-unsubdir cur-dir))))
  1766.  
  1767. (defun dired-unsubdir (dir)
  1768.   ;; Remove DIR from the alist
  1769.   (setq dired-subdir-alist
  1770.     (delq (assoc dir dired-subdir-alist) dired-subdir-alist)))
  1771.  
  1772. ;;;###autoload
  1773. (defun dired-tree-up (arg)
  1774.   "Go up ARG levels in the dired tree."
  1775.   (interactive "p")
  1776.   (let ((dir (dired-current-directory)))
  1777.     (while (>= arg 1)
  1778.       (setq arg (1- arg)
  1779.         dir (file-name-directory (directory-file-name dir))))
  1780.     ;;(setq dir (expand-file-name dir))
  1781.     (or (dired-goto-subdir dir)
  1782.     (error "Cannot go up to %s - not in this tree." dir))))
  1783.  
  1784. ;;;###autoload
  1785. (defun dired-tree-down ()
  1786.   "Go down in the dired tree."
  1787.   (interactive)
  1788.   (let ((dir (dired-current-directory)) ; has slash
  1789.     pos case-fold-search)        ; filenames are case sensitive
  1790.     (let ((rest (reverse dired-subdir-alist)) elt)
  1791.       (while rest
  1792.     (setq elt (car rest)
  1793.           rest (cdr rest))
  1794.     (if (dired-in-this-tree (directory-file-name (car elt)) dir)
  1795.         (setq rest nil
  1796.           pos (dired-goto-subdir (car elt))))))
  1797.     (if pos
  1798.     (goto-char pos)
  1799.       (error "At the bottom"))))
  1800.  
  1801. ;;; hiding
  1802.  
  1803. (defun dired-unhide-subdir ()
  1804.   (let (buffer-read-only)
  1805.     (subst-char-in-region (dired-subdir-min) (dired-subdir-max) ?\r ?\n)))
  1806.  
  1807. (defun dired-hide-check ()
  1808.   (or selective-display
  1809.       (error "selective-display must be t for subdir hiding to work!")))
  1810.  
  1811. (defun dired-subdir-hidden-p (dir)
  1812.   (and selective-display
  1813.        (save-excursion
  1814.      (dired-goto-subdir dir)
  1815.      (looking-at "\r"))))
  1816.  
  1817. ;;;###autoload
  1818. (defun dired-hide-subdir (arg)
  1819.   "Hide or unhide the current subdirectory and move to next directory.
  1820. Optional prefix arg is a repeat factor.
  1821. Use \\[dired-hide-all] to (un)hide all directories."
  1822.   (interactive "p")
  1823.   (dired-hide-check)
  1824.   (while (>=  (setq arg (1- arg)) 0)
  1825.     (let* ((cur-dir (dired-current-directory))
  1826.        (hidden-p (dired-subdir-hidden-p cur-dir))
  1827.        (elt (assoc cur-dir dired-subdir-alist))
  1828.        (end-pos (1- (dired-get-subdir-max elt)))
  1829.        buffer-read-only)
  1830.       ;; keep header line visible, hide rest
  1831.       (goto-char (dired-get-subdir-min elt))
  1832.       (skip-chars-forward "^\n\r")
  1833.       (if hidden-p
  1834.       (subst-char-in-region (point) end-pos ?\r ?\n)
  1835.     (subst-char-in-region (point) end-pos ?\n ?\r)))
  1836.     (dired-next-subdir 1 t)))
  1837.  
  1838. ;;;###autoload
  1839. (defun dired-hide-all (arg)
  1840.   "Hide all subdirectories, leaving only their header lines.
  1841. If there is already something hidden, make everything visible again.
  1842. Use \\[dired-hide-subdir] to (un)hide a particular subdirectory."
  1843.   (interactive "P")
  1844.   (dired-hide-check)
  1845.   (let (buffer-read-only)
  1846.     (if (save-excursion
  1847.       (goto-char (point-min))
  1848.       (search-forward "\r" nil t))
  1849.     ;; unhide - bombs on \r in filenames
  1850.     (subst-char-in-region (point-min) (point-max) ?\r ?\n)
  1851.       ;; hide
  1852.       (let ((pos (point-max))        ; pos of end of last directory
  1853.         (alist dired-subdir-alist))
  1854.     (while alist            ; while there are dirs before pos
  1855.       (subst-char-in-region (dired-get-subdir-min (car alist)) ; pos of prev dir
  1856.                 (save-excursion
  1857.                   (goto-char pos) ; current dir
  1858.                   ;; we're somewhere on current dir's line
  1859.                   (forward-line -1)
  1860.                   (point))
  1861.                 ?\n ?\r)
  1862.       (setq pos (dired-get-subdir-min (car alist)))    ; prev dir gets current dir
  1863.       (setq alist (cdr alist)))))))
  1864.  
  1865. ;;;###end dired-ins.el
  1866.  
  1867.  
  1868. ;; Functions for searching in tags style among marked files.
  1869.  
  1870. ;;;###autoload
  1871. (defun dired-do-search (regexp)
  1872.   "Search through all marked files for a match for REGEXP.
  1873. Stops when a match is found.
  1874. To continue searching for next match, use command \\[tags-loop-continue]."
  1875.   (interactive "sSearch marked files (regexp): ")
  1876.   (tags-search regexp '(dired-get-marked-files)))
  1877.  
  1878. ;;;###autoload
  1879. (defun dired-do-query-replace (from to &optional delimited)
  1880.   "Do `query-replace-regexp' of FROM with TO, on all marked files.
  1881. Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
  1882. If you exit (\\[keyboard-quit] or ESC), you can resume the query replace
  1883. with the command \\[tags-loop-continue]."
  1884.   (interactive
  1885.    "sQuery replace in marked files (regexp): \nsQuery replace %s by: \nP")
  1886.   (tags-query-replace from to delimited '(dired-get-marked-files)))
  1887.  
  1888.  
  1889. (provide 'dired-aux)
  1890.  
  1891. ;;; dired-aux.el ends here
  1892.